Vcenter NamespaceManagement Networks VsphereDVPGNetworkCreateSpec

The Vcenter NamespaceManagement Networks VsphereDVPGNetworkCreateSpec schema describes the configuration specification of a vSphere DVPG-backed Namespaces Network object.

This schema was added in vSphere API 7.0.1.0.

JSON Example

{
    "portgroup": "string",
    "ip_assignment_mode": "string",
    "address_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "gateway": "string",
    "subnet_mask": "string",
    "mode": "string"
}

string

portgroup

Required

Identifier of the vSphere Distributed Portgroup backing the vSphere network object.

This property was added in vSphere API 7.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network.

string

ip_assignment_mode

Optional

IP address assignment mode. If set to DHCP, then field Vcenter NamespaceManagement Networks VsphereDVPGNetworkCreateSpec.address_ranges must be set to an empty list and fields Vcenter NamespaceManagement Networks VsphereDVPGNetworkCreateSpec.gateway and Vcenter NamespaceManagement Networks VsphereDVPGNetworkCreateSpec.subnet_mask must be set to empty strings.

For more information see: Vcenter NamespaceManagement Networks IPAssignmentMode.

This property was added in vSphere API 7.0.3.0.

If missing or null, defaults to STATICRANGE.

array of Vcenter NamespaceManagement IPRange

address_ranges

Required

Usable IP pools on this network.

This property was added in vSphere API 7.0.1.0.

string

gateway

Required

Gateway for the network.

This property was added in vSphere API 7.0.1.0.

string

subnet_mask

Required

Subnet mask of the network.

This property was added in vSphere API 7.0.1.0.

string

mode

Optional

Assigns a mode to a network. A mode describes the intended use of the network.

For more information see: Vcenter NamespaceManagement Networks Mode.

This property was added in vSphere API 9.0.0.0.

If missing or null this network defaults to the Vcenter NamespaceManagement Networks Mode.WORKLOAD mode.